net: coap_client: Add optional payload callback for uploads #97107
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
During block uploads, the server may respond with Block 1 option with a smaller block size than currently used (so called block size negotiation). The CoAP client however did not read the Block 1 option from the response, therefore ignoring the server request to lower the block size. Signed-off-by: Robert Lubos <[email protected]>
Add an optional payload callback field to the coap_client_request structure, allowing the application to provide blocks of payload interactively during the resource upload, instead of having to provide entire payload in a single contigunous memory space. If registered, the CoAP client library will call the payload callback whenever a new PUT/POST message is being generated (note this is also true for retransmissions) instead of using the payload pointer/length. If the payload callback is NULL, then the library operates as usual. Signed-off-by: Robert Lubos <[email protected]>
zephyrbot
added
area: Networking
Release Notes
Add a new sample demonstrating various ways of performing CoAP uploads with the CoAP Client library: * short uploads with payload pointer * short uploads with payload callback * block transfer uploads with payload pointer * block transfer uploads with payload callback The resource names have been chosen so that the sample can run out of the box against the Zephyr's CoAP server sample. Signed-off-by: Robert Lubos <[email protected]>
rlubos
force-pushed
the
net/coap-upload-cb
branch
from
f033929 to
e2f2a01
Compare
1 task
jukkar
reviewed
Oct 8, 2025
Document the usage of the payload callback in the CoAP client documentation page. Signed-off-by: Robert Lubos <[email protected]>
Add release notes entry covering the new CoAP client payload callback. Signed-off-by: Robert Lubos <[email protected]>
rlubos
force-pushed
the
net/coap-upload-cb
branch
from
e2f2a01 to
7a8a65d
Compare
pdgendt
approved these changes
Oct 8, 2025
| provide a single contiguous buffer with the entire payload. An example callback, providing the | ||
| content of the Lorem Ipsum string can look like this: | ||
|
|
||
| .. code-block:: c |
There was a problem hiding this comment.
I hate to whine about this, but I dislike the fact that our code samples in the documentation do not adhere to our code style (tabs vs spaces). And it's an annoyance to do it properly, because rst file uses spaces for indentation, while our c code uses tabs.
I worked around this by using literalinclude:: directives instead of inline code, but that isn't ideal either.
There was a problem hiding this comment.
Yeah but that probably would need to be brought to a broader audience, it's everywhere like this from what I see, it's not only this file.
|
jukkar
approved these changes
Oct 8, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The main purpose of this PR is to add support for optional payload callback for CoAP client uploads. Additionally:
Resolves #59571